docs: use the dynamic README header endpoint by AlemTuzlak · Pull Request #2266 · TanStack/form

AlemTuzlak · 2026-08-03T09:19:17Z

Adopts the dynamic README header endpoint added in TanStack/tanstack.com#1076,
which is merged and live.

Every README banner in this repo now points a <picture> at
https://tanstack.com/api/readme/ instead of a committed PNG. The endpoint
renders 1800x450 in light and dark, so a branding change lands in every README
at once and dark-mode readers get a dark banner.

What changed

12 README(s) updated.
Light and dark served through <picture>, per GitHub's guidance. The trailing <img> stays the light variant, as the fallback for renderers that ignore <picture> (npm, most editors).
Per-package READMEs pass ?framework= so each banner shows its own package name instead of the generic library name.
Deletes the now-unused media/header_form.png.

The package READMEs were pointing at media/repo-header.png, the GitHub social-preview image. That file stays where it is - only the README references change.

Verification

Every generated URL in this diff was requested against the live endpoint and
returned 200 image/png at 1800x450. git grep confirms no README still
references the old media/header_*.png path.

Heads up: deleting the committed PNG means npm pages for already-published
versions that embed the github.com/ghraw/.../main/media/header_*.png
link will show a broken image, since that link is branch-pinned. New releases
pick up the endpoint URL.

Summary by CodeRabbit

Documentation
- Updated project and package README header images to use responsive light- and dark-theme variants.
- Added descriptive alternative text to improve accessibility.
- Improved image sizing and included fallback images where applicable for more consistent rendering across browsers and themes.

coderabbitai · 2026-08-03T09:19:36Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 6a241ea8-4e58-4bae-8825-a3c3488d2136

📥 Commits

Reviewing files that changed from the base of the PR and between 028fcdd and 34a86d0.

⛔ Files ignored due to path filters (1)

media/header_form.png is excluded by !**/*.png

📒 Files selected for processing (12)

README.md
packages/angular-form/README.md
packages/form-devtools/README.md
packages/lit-form/README.md
packages/preact-form/README.md
packages/react-form-devtools/README.md
packages/react-form-nextjs/README.md
packages/react-form-remix/README.md
packages/react-form-start/README.md
packages/react-form/README.md
packages/solid-form/README.md
packages/vue-form/README.md

📝 Walkthrough

Walkthrough

README header images now use responsive <picture> elements with light and dark theme sources. The updates also add fallback images, descriptive alt text, and width metadata across the repository and form package documentation.

Changes

README header images

Layer / File(s)	Summary
Responsive header markup `README.md`, `packages/*/README.md`	Static header images are replaced with theme-aware responsive `<picture>` markup. The images include fallback sources, descriptive alt text, and fixed widths where specified.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: crutchcorn

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly describes the main change: replacing README images with a dynamic header endpoint.
Description check	✅ Passed	The description clearly explains the changes, verification, release impact, and known compatibility risk.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch readme-header-endpoint

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

nx-cloud · 2026-08-03T09:21:05Z

View your CI Pipeline Execution ↗ for commit 34a86d0

Command	Status	Duration	Result
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	2m 39s	View ↗
`nx run-many --target=build --exclude=examples/**`	✅ Succeeded	<1s	View ↗

☁️ Nx Cloud last updated this comment at 2026-08-03 09:24:34 UTC

github-actions · 2026-08-03T09:21:38Z

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

pkg-pr-new · 2026-08-03T09:21:41Z

More templates

@tanstack/angular-form

npm i https://pkg.pr.new/@tanstack/angular-form@2266

@tanstack/form-core

npm i https://pkg.pr.new/@tanstack/form-core@2266

@tanstack/form-devtools

npm i https://pkg.pr.new/@tanstack/form-devtools@2266

@tanstack/lit-form

npm i https://pkg.pr.new/@tanstack/lit-form@2266

@tanstack/preact-form

npm i https://pkg.pr.new/@tanstack/preact-form@2266

@tanstack/react-form

npm i https://pkg.pr.new/@tanstack/react-form@2266

@tanstack/react-form-devtools

npm i https://pkg.pr.new/@tanstack/react-form-devtools@2266

@tanstack/react-form-nextjs

npm i https://pkg.pr.new/@tanstack/react-form-nextjs@2266

@tanstack/react-form-remix

npm i https://pkg.pr.new/@tanstack/react-form-remix@2266

@tanstack/react-form-start

npm i https://pkg.pr.new/@tanstack/react-form-start@2266

@tanstack/solid-form

npm i https://pkg.pr.new/@tanstack/solid-form@2266

@tanstack/solid-form-devtools

npm i https://pkg.pr.new/@tanstack/solid-form-devtools@2266

@tanstack/svelte-form

npm i https://pkg.pr.new/@tanstack/svelte-form@2266

@tanstack/vue-form

npm i https://pkg.pr.new/@tanstack/vue-form@2266

commit: 34a86d0

codecov-commenter · 2026-08-03T09:25:10Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.68%. Comparing base (6892ed0) to head (34a86d0).
⚠️ Report is 263 commits behind head on main.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2266      +/-   ##
==========================================
- Coverage   90.35%   84.68%   -5.67%     
==========================================
  Files          38       45       +7     
  Lines        1752      960     -792     
  Branches      444       96     -348     
==========================================
- Hits         1583      813     -770     
+ Misses        149      129      -20     
+ Partials       20       18       -2

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

* docs: use the dynamic README header endpoint (#2266) * docs: fix sidebar 404s and validate config.json nav targets (#2278) * docs(config): remove nav entries pointing at non-existent reference pages Six sidebar entries in docs/config.json referenced reference pages that do not exist, so each rendered as a 404. FieldMeta, FieldState and FieldInfo lost their generated pages in 6a73479 without config.json being updated to match. useTransform is not exported from @tanstack/react-form, and vue/solid never had UseField/CreateField types. Repoint the FieldMeta entry to AnyFieldMeta, the surviving public field-metadata type, and drop the rest. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017z89Nb8dzFPu7VnsvN2VA9 * chore(scripts): verify docs/config.json nav targets in verify-links verify-links only extracted links written inside .md files, so sidebar entries in docs/config.json were never checked and could point at pages that no longer exist without failing CI. Walk every `to` in the nav config and resolve it the same way markdown links are resolved, including the framework examples directory mapping. Failures report the nav breadcrumb so the offending entry is easy to locate. The shared resolution logic is extracted into resolveDocTarget so the two checks cannot drift apart. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017z89Nb8dzFPu7VnsvN2VA9 * fix(scripts): fail verify-links when the check itself throws The rejection handler only logged, so Node still exited 0. Reading or parsing docs/config.json can now throw, which meant test:docs could pass while the navigation check never ran. Confirmed by pointing the script at malformed and missing config files: both exited 0 before this change and exit 1 after. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017z89Nb8dzFPu7VnsvN2VA9 --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com> # Conflicts: # docs/config.json --------- Co-authored-by: Irfan fandi <irfanfandi38@gmail.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>

docs: use the dynamic README header endpoint

34a86d0

harry-whorlow merged commit 093ce62 into main Aug 3, 2026
9 checks passed

harry-whorlow deleted the readme-header-endpoint branch August 3, 2026 09:44

crutchcorn mentioned this pull request Aug 8, 2026

[v2] Alpha docs improvements #2283

Merged

Navigation Menu

Uh oh!

Uh oh!

docs: use the dynamic README header endpoint - #2266

docs: use the dynamic README header endpoint#2266
harry-whorlow merged 1 commit into
mainfrom
readme-header-endpoint

AlemTuzlak commented Aug 3, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Aug 3, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

nx-cloud Bot commented Aug 3, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Aug 3, 2026

Uh oh!

pkg-pr-new Bot commented Aug 3, 2026

Uh oh!

codecov-commenter commented Aug 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

AlemTuzlak commented Aug 3, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changed

Verification

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

nx-cloud Bot commented Aug 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 3, 2026

🚀 Changeset Version Preview

Uh oh!

pkg-pr-new Bot commented Aug 3, 2026

Uh oh!

codecov-commenter commented Aug 3, 2026

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AlemTuzlak commented Aug 3, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 3, 2026 •

edited

Loading

nx-cloud Bot commented Aug 3, 2026 •

edited

Loading